Create Action Class
curl --request POST \
--url 'http://{{baseurl}}/api/v1/management/action-classes' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"description": "From API Docs (optional)",
"environmentId": "{{environmentId}}",
"name": "My Action from Postman",
"noCodeConfig": {
"innerHtml": {
"value": "sign-up"
},
"type": "innerHtml"
},
"type": "code"
}
'import requests
url = "http://{{baseurl}}/api/v1/management/action-classes"
payload = {
"description": "From API Docs (optional)",
"environmentId": "{{environmentId}}",
"name": "My Action from Postman",
"noCodeConfig": {
"innerHtml": { "value": "sign-up" },
"type": "innerHtml"
},
"type": "code"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'From API Docs (optional)',
environmentId: '{{environmentId}}',
name: 'My Action from Postman',
noCodeConfig: {innerHtml: {value: 'sign-up'}, type: 'innerHtml'},
type: 'code'
})
};
fetch('http://{{baseurl}}/api/v1/management/action-classes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "http://{{baseurl}}/api/v1/management/action-classes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'From API Docs (optional)',
'environmentId' => '{{environmentId}}',
'name' => 'My Action from Postman',
'noCodeConfig' => [
'innerHtml' => [
'value' => 'sign-up'
],
'type' => 'innerHtml'
],
'type' => 'code'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://{{baseurl}}/api/v1/management/action-classes"
payload := strings.NewReader("{\n \"description\": \"From API Docs (optional)\",\n \"environmentId\": \"{{environmentId}}\",\n \"name\": \"My Action from Postman\",\n \"noCodeConfig\": {\n \"innerHtml\": {\n \"value\": \"sign-up\"\n },\n \"type\": \"innerHtml\"\n },\n \"type\": \"code\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://{{baseurl}}/api/v1/management/action-classes")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"From API Docs (optional)\",\n \"environmentId\": \"{{environmentId}}\",\n \"name\": \"My Action from Postman\",\n \"noCodeConfig\": {\n \"innerHtml\": {\n \"value\": \"sign-up\"\n },\n \"type\": \"innerHtml\"\n },\n \"type\": \"code\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{{baseurl}}/api/v1/management/action-classes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"From API Docs (optional)\",\n \"environmentId\": \"{{environmentId}}\",\n \"name\": \"My Action from Postman\",\n \"noCodeConfig\": {\n \"innerHtml\": {\n \"value\": \"sign-up\"\n },\n \"type\": \"innerHtml\"\n },\n \"type\": \"code\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"createdAt": "2024-04-23T08:58:47.507Z",
"description": null,
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc5m82c000z494jkvnw1gh0",
"name": "My Action from Postman",
"noCodeConfig": null,
"type": "code",
"updatedAt": "2024-04-23T08:58:47.507Z"
}
}{
"code": "bad_request",
"details": {},
"message": "Database error when creating an action for environment clurwouax000azffxt7n5unn3"
}Management API > Action Class
Create Action Class
Create Action Class from the UI or from the API! You can read more about them here.
POST
/
api
/
v1
/
management
/
action-classes
Create Action Class
curl --request POST \
--url 'http://{{baseurl}}/api/v1/management/action-classes' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"description": "From API Docs (optional)",
"environmentId": "{{environmentId}}",
"name": "My Action from Postman",
"noCodeConfig": {
"innerHtml": {
"value": "sign-up"
},
"type": "innerHtml"
},
"type": "code"
}
'import requests
url = "http://{{baseurl}}/api/v1/management/action-classes"
payload = {
"description": "From API Docs (optional)",
"environmentId": "{{environmentId}}",
"name": "My Action from Postman",
"noCodeConfig": {
"innerHtml": { "value": "sign-up" },
"type": "innerHtml"
},
"type": "code"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'From API Docs (optional)',
environmentId: '{{environmentId}}',
name: 'My Action from Postman',
noCodeConfig: {innerHtml: {value: 'sign-up'}, type: 'innerHtml'},
type: 'code'
})
};
fetch('http://{{baseurl}}/api/v1/management/action-classes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "http://{{baseurl}}/api/v1/management/action-classes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'From API Docs (optional)',
'environmentId' => '{{environmentId}}',
'name' => 'My Action from Postman',
'noCodeConfig' => [
'innerHtml' => [
'value' => 'sign-up'
],
'type' => 'innerHtml'
],
'type' => 'code'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://{{baseurl}}/api/v1/management/action-classes"
payload := strings.NewReader("{\n \"description\": \"From API Docs (optional)\",\n \"environmentId\": \"{{environmentId}}\",\n \"name\": \"My Action from Postman\",\n \"noCodeConfig\": {\n \"innerHtml\": {\n \"value\": \"sign-up\"\n },\n \"type\": \"innerHtml\"\n },\n \"type\": \"code\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://{{baseurl}}/api/v1/management/action-classes")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"From API Docs (optional)\",\n \"environmentId\": \"{{environmentId}}\",\n \"name\": \"My Action from Postman\",\n \"noCodeConfig\": {\n \"innerHtml\": {\n \"value\": \"sign-up\"\n },\n \"type\": \"innerHtml\"\n },\n \"type\": \"code\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{{baseurl}}/api/v1/management/action-classes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"From API Docs (optional)\",\n \"environmentId\": \"{{environmentId}}\",\n \"name\": \"My Action from Postman\",\n \"noCodeConfig\": {\n \"innerHtml\": {\n \"value\": \"sign-up\"\n },\n \"type\": \"innerHtml\"\n },\n \"type\": \"code\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"createdAt": "2024-04-23T08:58:47.507Z",
"description": null,
"environmentId": "clurwouax000azffxt7n5unn3",
"id": "clvc5m82c000z494jkvnw1gh0",
"name": "My Action from Postman",
"noCodeConfig": null,
"type": "code",
"updatedAt": "2024-04-23T08:58:47.507Z"
}
}{
"code": "bad_request",
"details": {},
"message": "Database error when creating an action for environment clurwouax000azffxt7n5unn3"
}Headers
Body
application/json
The body is of type object.
Response
OK
The response is of type object.
Was this page helpful?
⌘I